Skip to content

FEAT: Add option for pep8 aliases in binding #1234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

FEAT: Add option for pep8 aliases in binding #1234

wants to merge 4 commits into from

Conversation

dipinknair
Copy link
Collaborator

This pull request refactors the _bind_assembly_for_explicit_interface function to make it more flexible and updates its usage in the initialize function. The refactored function now supports additional options for binding assemblies, including enabling PEP 8 aliases.

Refactoring of _bind_assembly_for_explicit_interface:

  • Renamed _bind_assembly_for_explicit_interface to _bind_assembly and added two optional parameters: explicit_interface and pep8_aliases. This allows the function to handle both explicit interface implementation and PEP 8 aliasing.
  • Updated the binding logic to conditionally set AllowExplicitInterfaceImplementation and Pep8Aliases based on the new parameters.

Updates to initialize function:

  • Replaced the call to _bind_assembly_for_explicit_interface with _bind_assembly and passed True for both explicit_interface and pep8_aliases arguments to enable these features for the "Ansys.ACT.WB1" assembly.

Usage:

app = App()
app.update_globals(globals())
print(app)

# CamelCase
geometry_import = Model.GeometryImportGroup.AddGeometryImport()
# pep8 formatting
geometry_import = Model.geometry_import_group.add_geometry_import()

@dipinknair dipinknair requested a review from a team as a code owner July 11, 2025 15:46
@dipinknair dipinknair requested a review from koubaa July 11, 2025 15:47
@github-actions github-actions bot added the enhancement New features or code improvements label Jul 11, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 11, 2025
koubaa
koubaa reviewed Jul 11, 2025
View reviewed changes
src/ansys/mechanical/core/embedding/runtime.py Outdated
@@ -86,4 +101,4 @@ def initialize(version: int) -> None:
__register_function_codec()
Logger.debug("Registered function codec")

_bind_assembly_for_explicit_interface("Ansys.ACT.WB1")
_bind_assembly("Ansys.ACT.WB1", True, True)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make it opt-in for now, like this:

app = App(pep8=True)

until it has gone through more usage/testing.

@codecov Codecov
Copy link

codecov bot commented Jul 11, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 71.42857% with 6 lines in your changes missing coverage. Please review.

Project coverage is 86.27%. Comparing base (09c9425) to head (0041143).

❌ Your patch check has failed because the patch coverage (71.42%) is below the target coverage (90.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1234      +/-   ##
==========================================
- Coverage   86.40%   86.27%   -0.13%     
==========================================
  Files          39       39              
  Lines        2537     2550      +13     
==========================================
+ Hits         2192     2200       +8     
- Misses        345      350       +5
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codacy-production Codacy Production
Copy link

codacy-production bot commented Jul 11, 2025 •
edited
Loading

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
✅ -0.13% (target: -1.00%) ✅ 71.43%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (09c9425) 2537 2192 86.40%
Head commit (0041143) 2550 (+13) 2200 (+8) 86.27% (-0.13%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#1234) 21 15 71.43%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@dipinknair dipinknair requested a review from koubaa July 14, 2025 18:34
koubaa
koubaa requested changes Jul 14, 2025
View reviewed changes
Copy link
Collaborator

@koubaa koubaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the opt-out section looks wrong to me

src/ansys/mechanical/core/embedding/app.py
@@ -231,7 +233,8 @@ def __init__(self, db_file=None, private_appdata=False, **kwargs):
profile = UniqueUserProfile(new_profile_name, copy_profile=copy_profile)
profile.update_environment(os.environ)

runtime.initialize(self._version)
_pep8_alias = kwargs.get("pep8", False)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ironically: leading underscore for a local variable isn't pep8 :)

src/ansys/mechanical/core/embedding/runtime.py
@@ -86,4 +100,16 @@ def initialize(version: int) -> None:
__register_function_codec()
Logger.debug("Registered function codec")

_bind_assembly_for_explicit_interface("Ansys.ACT.WB1")
explicit_interface = True # Currently no option to disable this
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why no option to disable - if you're adding all these env vars?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koubaa koubaa koubaa requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dipinknair @koubaa @pyansys-ci-bot